Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat:Update OpenAPI specification for AI21 Studio API and modify ChatRequest schema #72

Closed
wants to merge 1 commit into from
Closed

feat:Update OpenAPI specification for AI21 Studio API and modify ChatRequest schema #72

wants to merge 1 commit into from

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Nov 17, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Enhanced ChatRequest schema with new required fields and properties for improved functionality.
  • Removed Features
    • Several endpoints related to the j2 model family have been removed, streamlining the API.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 17, 2024 •
edited
Loading

Walkthrough

The pull request introduces significant changes to the OpenAPI specification for the AI21 Studio API. It removes multiple endpoints associated with the j2 model family and updates the ChatRequest schema. The new schema simplifies references and modifies required fields, adding several new properties to enhance functionality.

Changes

File Change Summary
src/libs/AI21/openapi.yaml Removed endpoints: /studio/v1/j2-light/complete, /studio/v1/j2-mid/complete, /studio/v1/j2-ultra/complete, /studio/v1/j2-large/complete, /studio/v1/j2-large-instruct/complete, /studio/v1/j2-grande/complete, /studio/v1/j2-jumbo/complete. Updated ChatRequest schema with new required fields and additional properties.

Possibly related PRs

🐰 In the meadow, changes bloom,
Removing paths that brought us gloom.
Chat requests now shine so bright,
With new fields to share delight.
A simpler way for all to play,
In the API's joyful ballet! 🌼

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1ba8c02 and 312a75c.

⛔ Files ignored due to path filters (118)
  • src/libs/AI21/Generated/AI21.Ai21Api.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ChatClient.V1J2UltraChat.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ChatClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2GrandeComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2GrandeInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboComplete2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2JumboInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2LargeComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2LargeInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2LightComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2MidComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2UltraComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.CompletionClient.V1J2UltraComplete2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IAi21Api.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IChatClient.V1J2UltraChat.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IChatClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2GrandeComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2GrandeInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboComplete2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2JumboInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LargeComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LargeInstructComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2LightComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2MidComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2UltraComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ICompletionClient.V1J2UltraComplete2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IJambaCompleteClient.V1ChatComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IParaphraseClient.V1Paraphraze.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.IParaphraseClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ISegmentationClient.V1Segmentation.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ISegmentationClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ISummarizeClient.V1Summarize.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ISummarizeClient.V1SummarizeBySegment.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ISummarizeClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.JambaCompleteClient.V1ChatComplete.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatMessage.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatOutput.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatOutput.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatRequest.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatRequest.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminator.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminator.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatRequestMessageDiscriminatorRole.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ChatResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.DocumentType.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.FinishReason.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.FinishReason.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.Highlight.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.Highlight.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequest.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminator.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRole.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesJ2ChatChatRequest.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.LanguageStudioApiServerDataTypesJ2ChatChatRequest.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.MessagesItem.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ParaphraseBody.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.ParaphraseBody.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.RoleType.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.Segment.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.Segment.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentSummary.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentSummary.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentationBody.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentationBody.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentationResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentationResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentedSummaryBody.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SegmentedSummaryBody.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.StyleType.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizationResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizationResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizeBody.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizeBody.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizeBySegmentResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummarizeBySegmentResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.SummaryMethod.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2GrandeCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2GrandeCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2GrandeInstructCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2GrandeInstructCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2JumboCompleteResponse2.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2JumboCompleteResponse2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2JumboInstructCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2JumboInstructCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2LargeCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2LargeInstructCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2LargeInstructCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2LightCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2LightCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2MidCompleteResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2MidCompleteResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2UltraCompleteResponse2.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1J2UltraCompleteResponse2.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1ParaphrazeResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.Models.V1ParaphrazeResponse.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ParaphraseClient.V1Paraphraze.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.ParaphraseClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.SegmentationClient.V1Segmentation.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.SegmentationClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.SummarizeClient.V1Summarize.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.SummarizeClient.V1SummarizeBySegment.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/AI21.SummarizeClient.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.ChatRequestMessageDiscriminatorRole.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.ChatRequestMessageDiscriminatorRoleNullable.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.DocumentTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRole.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.LanguageStudioApiServerDataTypesChatChatRequestMessageDiscriminatorRoleNullable.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.MessagesItem.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.RoleType.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.RoleTypeNullable.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.StyleType.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.SummaryMethod.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonConverters.SummaryMethodNullable.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
  • src/libs/AI21/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/AI21/openapi.yaml (2 hunks)
🔇 Additional comments (1)
src/libs/AI21/openapi.yaml (1)

1034-1112: LGTM! Well-structured ChatRequest schema update.

The changes to the ChatRequest schema are well-implemented with:

  • Clear required fields (model, messages)
  • Comprehensive message role discrimination
  • Well-documented properties with appropriate constraints and defaults
  • Enhanced flexibility through new optional parameters

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot enabled auto-merge November 17, 2024 15:20
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update OpenAPI specification for AI21 Studio API and modify ChatRequest schema Nov 17, 2024
@HavenDV HavenDV closed this Nov 17, 2024
auto-merge was automatically disabled November 17, 2024 19:57

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@HavenDV